<!DOCTYPE HTML>

<html lang="en">
<head>

<title>DefaultSpringSecurityContextSource (spring-security-docs 5.6.3 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="DefaultSpringSecurityContextSource (spring-security-docs 5.6.3 API)";
        }
    }
    catch(err) {
    }
//-->
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">

<div class="topNav"><a id="navbar.top">

</a>
<div class="skipNav"><a href="DefaultSpringSecurityContextSource.html#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="DefaultSpringSecurityContextSource.html#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="DefaultSpringSecurityContextSource.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="DefaultSpringSecurityContextSource.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="DefaultSpringSecurityContextSource.html#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="DefaultSpringSecurityContextSource.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a id="skip.navbar.top">

</a></div>

</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>

<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.springframework.security.ldap</a></div>
<h2 title="Class DefaultSpringSecurityContextSource" class="title">Class DefaultSpringSecurityContextSource</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.springframework.ldap.core.support.AbstractContextSource</li>
<li>
<ul class="inheritance">
<li>org.springframework.ldap.core.support.LdapContextSource</li>
<li>
<ul class="inheritance">
<li>org.springframework.security.ldap.DefaultSpringSecurityContextSource</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>org.springframework.beans.factory.InitializingBean</code>, <code>org.springframework.ldap.core.ContextSource</code>, <code>org.springframework.ldap.core.support.BaseLdapPathContextSource</code>, <code>org.springframework.ldap.core.support.BaseLdapPathSource</code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="ppolicy/PasswordPolicyAwareContextSource.html" title="class in org.springframework.security.ldap.ppolicy">PasswordPolicyAwareContextSource</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">DefaultSpringSecurityContextSource</span>
extends org.springframework.ldap.core.support.LdapContextSource</pre>
<div class="block">ContextSource implementation which uses Spring LDAP's <tt>LdapContextSource</tt> as a
base class. Used internally by the Spring Security LDAP namespace configuration.
<p>
From Spring Security 3.0, Spring LDAP 1.3 is used and the <tt>ContextSource</tt>
interface provides support for binding with a username and password. As a result,
Spring LDAP <tt>ContextSource</tt> implementations such as <tt>LdapContextSource</tt>
may be used directly with Spring Security.
<p>
Spring LDAP 1.3 doesn't have JVM-level LDAP connection pooling enabled by default. This
class sets the <tt>pooled</tt> property to true, but customizes the
<code>DirContextAuthenticationStrategy</code> used to disable pooling when the <tt>DN</tt>
doesn't match the <tt>userDn</tt> property. This prevents pooling for calls to
<code>AbstractContextSource.getContext(String, String)</code> to authenticate as specific users.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">

</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.apache.commons.logging.Log</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="DefaultSpringSecurityContextSource.html#logger">logger</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.springframework.ldap.core.support.AbstractContextSource">

</a>
<h3>Fields inherited from class&nbsp;org.springframework.ldap.core.support.AbstractContextSource</h3>
<code>password, SUN_LDAP_POOLING_FLAG, userDn</code></li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">

</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="DefaultSpringSecurityContextSource.html#%3Cinit%3E(java.lang.String)">DefaultSpringSecurityContextSource</a></span>&#8203;(java.lang.String&nbsp;providerUrl)</code></th>
<td class="colLast">
<div class="block">Create and initialize an instance which will connect to the supplied LDAP URL.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="DefaultSpringSecurityContextSource.html#%3Cinit%3E(java.util.List,java.lang.String)">DefaultSpringSecurityContextSource</a></span>&#8203;(java.util.List&lt;java.lang.String&gt;&nbsp;urls,
java.lang.String&nbsp;baseDn)</code></th>
<td class="colLast">
<div class="block">Create and initialize an instance which will connect of the LDAP Spring Security
Context Source.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">

</a>
<h3>Method Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.springframework.ldap.core.support.LdapContextSource">

</a>
<h3>Methods inherited from class&nbsp;org.springframework.ldap.core.support.LdapContextSource</h3>
<code>getDirContextInstance</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.springframework.ldap.core.support.AbstractContextSource">

</a>
<h3>Methods inherited from class&nbsp;org.springframework.ldap.core.support.AbstractContextSource</h3>
<code>afterPropertiesSet, assembleProviderUrlString, createContext, getAnonymousEnv, getAuthenticatedEnv, getAuthenticationSource, getBaseLdapName, getBaseLdapPath, getBaseLdapPathAsString, getContext, getContextFactory, getDirObjectFactory, getPassword, getReadOnlyContext, getReadWriteContext, getUrls, getUserDn, isAnonymousReadOnly, isPooled, setAnonymousReadOnly, setAuthenticationSource, setAuthenticationStrategy, setBase, setBaseEnvironmentProperties, setCacheEnvironmentProperties, setContextFactory, setDirObjectFactory, setPassword, setPooled, setReferral, setupAuthenticatedEnvironment, setUrl, setUrls, setUserDn</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">

</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">

</a>
<h3>Field Detail</h3>
<a id="logger">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>logger</h4>
<pre>protected final&nbsp;org.apache.commons.logging.Log logger</pre>
</li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">

</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(java.lang.String)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>DefaultSpringSecurityContextSource</h4>
<pre>public&nbsp;DefaultSpringSecurityContextSource&#8203;(java.lang.String&nbsp;providerUrl)</pre>
<div class="block">Create and initialize an instance which will connect to the supplied LDAP URL. If
you want to use more than one server for fail-over, rather use the
<a href="DefaultSpringSecurityContextSource.html#%3Cinit%3E(java.util.List,java.lang.String)"><code>DefaultSpringSecurityContextSource(List, String)</code></a> constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>providerUrl</code> - an LDAP URL of the form
<code>ldap://localhost:389/base_dn</code></dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(java.util.List,java.lang.String)">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DefaultSpringSecurityContextSource</h4>
<pre>public&nbsp;DefaultSpringSecurityContextSource&#8203;(java.util.List&lt;java.lang.String&gt;&nbsp;urls,
                                          java.lang.String&nbsp;baseDn)</pre>
<div class="block">Create and initialize an instance which will connect of the LDAP Spring Security
Context Source. It will connect to any of the provided LDAP server URLs.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>urls</code> - A list of string values which are LDAP server URLs. An example would be
<code>ldap://ldap.company.com:389</code>. LDAPS URLs (SSL-secured) may be used as
well, given that Spring Security is able to connect to the server. Note that these
<b>URLs must not include the base DN</b>!</dd>
<dd><code>baseDn</code> - The common Base DN for all provided servers, e.g.
<pre> dc=company,dc=com
 </pre>
.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>

<footer role="contentinfo">
<nav role="navigation">

<div class="bottomNav"><a id="navbar.bottom">

</a>
<div class="skipNav"><a href="DefaultSpringSecurityContextSource.html#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="DefaultSpringSecurityContextSource.html#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="DefaultSpringSecurityContextSource.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="DefaultSpringSecurityContextSource.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="DefaultSpringSecurityContextSource.html#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="DefaultSpringSecurityContextSource.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a id="skip.navbar.bottom">

</a></div>

</nav>
</footer>
<script>if (window.parent == window) {(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create', 'UA-2728886-23', 'auto', {'siteSpeedSampleRate': 100});ga('send', 'pageview');}</script><script defer src="https://static.cloudflareinsights.com/beacon.min.js/v652eace1692a40cfa3763df669d7439c1639079717194" integrity="sha512-Gi7xpJR8tSkrpF7aordPZQlW2DLtzUlZcumS8dMQjwDHEnw9I7ZLyiOj/6tZStRBGtGgN6ceN6cMH8z7etPGlw==" data-cf-beacon='{"rayId":"7040cd4d7b5e980c","token":"bffcb8a918ae4755926f76178bfbd26b","version":"2021.12.0","si":100}' crossorigin="anonymous"></script>
</body>
</html>
